Fix docs deployment from tag triggers by using workflow_dispatch#633
Merged
laughingman7743 merged 3 commits intomasterfrom Jan 1, 2026
Merged
Fix docs deployment from tag triggers by using workflow_dispatch#633laughingman7743 merged 3 commits intomasterfrom
laughingman7743 merged 3 commits intomasterfrom
Conversation
Always checkout master branch in the docs workflow, even when triggered by a tag push. This ensures GitHub Pages accepts the deployment since it's configured with source.branch: master. sphinx-multiversion still builds all versions (tags + master) because fetch-depth: 0 fetches all refs. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
GitHub Pages only accepts deployments from the master branch context. When a tag push triggered the docs workflow, the deployment would silently fail to update the live site. This change: - Removes the tag trigger from docs.yaml - Adds docs-trigger.yaml that triggers the docs workflow via workflow_dispatch API when a tag is pushed - This ensures the docs workflow always runs in master context while still being triggered by tag releases 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
laughingman7743
changed the title
The workflow now only runs from master context (push to master or workflow_dispatch with ref: master), so explicit ref is redundant. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs-trigger.yaml) that triggers the docs workflow viaworkflow_dispatchAPI when a tag is pusheddocs.yamlto ensure deployments always run in master contextProblem
When a tag (e.g., v3.23.0) triggers the docs workflow:
This is because GitHub Pages is configured with
source.branch: master, and deployments from tag refs are silently ignored.Solution
Instead of triggering the docs workflow directly from tag pushes, use a separate workflow that:
on: push: tags: ['v*'])ref: masterThe
actions: writepermission is required to trigger workflows via the API.Changes
.github/workflows/docs-trigger.yaml- New workflow to trigger docs on tag push.github/workflows/docs.yaml- Removedtags: ['v*']triggerTest plan
🤖 Generated with Claude Code